﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once
#include <string>
#include "GmFamilyDataStandard.h"

namespace gfam
{
    // \brief 领域对象接口
    class GM_FAMILY_DATA_STANDARD_EXPORT IFamilyDirectory
    {
    public:
        virtual ~IFamilyDirectory() = 0 {}

        /// \brief 获取分类的uid
        /// 
        /// \return 返回uid
        virtual std::wstring GetUid() const = 0;
        
        /// \brief 获取分类的code
        /// 
        /// \return 返回code
        virtual std::wstring GetCode() const = 0;
        
        /// \brief 获取名称
        /// 
        /// \return 返回name
        virtual std::wstring GetName() const = 0;
        
        /// \brief 分类是否是类别
        /// 
        /// \return 返回true表示这个分类是类别
        virtual bool IsClassification() const = 0;
        
        /// \brief 排序字段，暂时未使用
        /// 
        /// \return 返回排序号
        virtual float GetSort() const = 0;

        /// \brief 获取可见性
        /// 
        /// \return 返回可见性
        virtual bool IsVisible() const = 0;
    };
}